Class UserPwdDirAuthentication

All Implemented Interfaces:
IExtendedPluginInfo

public class UserPwdDirAuthentication extends DirBasedAuthentication
uid/pwd directory based authentication manager

Version:
$Revision$, $Date$
  • Field Details

    • logger

      public static org.slf4j.Logger logger
    • mAttr

      public String mAttr
    • mRequiredCreds

      protected String[] mRequiredCreds
    • mAttrName

      protected String mAttrName
    • mAttrDesc

      protected String mAttrDesc
    • mMemberAttrName

      protected String mMemberAttrName
    • mMemberAttrValue

      protected String mMemberAttrValue
    • mInternalGroup

      protected String mInternalGroup
    • mInternalUserRequired

      protected boolean mInternalUserRequired
    • mUGS

      protected UGSubsystem mUGS
    • mAttrs

      protected String[] mAttrs
    • mConfigParams

      protected static String[] mConfigParams
  • Constructor Details

    • UserPwdDirAuthentication

      public UserPwdDirAuthentication()
      Default constructor, initialization must follow.
  • Method Details

    • init

      public void init(AuthenticationConfig authenticationConfig, String name, String implName, AuthManagerConfig config) throws EBaseException
      Initializes the UserPwdDirAuthentication auth manager.

      Overrides:
      init in class DirBasedAuthentication
      Parameters:
      name - - The name for this authentication manager instance.
      implName - - The name of the authentication manager plugin.
      config - - The configuration store for this instance.
      Throws:
      EBaseException - If an error occurs during initialization.
    • authenticate

      protected String authenticate(netscape.ldap.LDAPConnection conn, AuthCredentials authCreds, AuthToken token) throws EBaseException
      Authenticates a user based on attr, pwd in the directory.
      Specified by:
      authenticate in class DirBasedAuthentication
      Parameters:
      authCreds - The authentication credentials.
      Returns:
      The user's ldap entry dn.
      Throws:
      EInvalidCredentials - If the attr and password are not valid
      EBaseException - If an internal error occurs.
    • getConfigParams

      public String[] getConfigParams()
      Returns a list of configuration parameter names. The list is passed to the configuration console so instances of this implementation can be configured through the console.
      Overrides:
      getConfigParams in class AuthManager
      Returns:
      String array of configuration parameter names.
    • getRequiredCreds

      public String[] getRequiredCreds()
      Returns array of required credentials for this authentication manager.
      Specified by:
      getRequiredCreds in class DirBasedAuthentication
      Returns:
      Array of required credentials.
    • init

      public void init(ConfigStore config) throws EProfileException
      Description copied from class: AuthManager
      Initializes this default policy.
      Specified by:
      init in class AuthManager
      Parameters:
      config - configuration store
      Throws:
      EProfileException - failed to initialize
    • getName

      public String getName(Locale locale)
      Retrieves the localizable name of this policy.
      Overrides:
      getName in class AuthManager
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator name
    • getText

      public String getText(Locale locale)
      Retrieves the localizable description of this policy.
      Overrides:
      getText in class DirBasedAuthentication
      Parameters:
      locale - end user locale
      Returns:
      localized authenticator description
    • getValueNames

      public Enumeration<String> getValueNames()
      Retrieves a list of names of the value parameter.
      Overrides:
      getValueNames in class DirBasedAuthentication
      Returns:
      a list of property names
    • isValueWriteable

      public boolean isValueWriteable(String name)
      Description copied from class: AuthManager
      Checks if the value of the given property should be serializable into the request. Passsword or other security-related value may not be desirable for storage.
      Overrides:
      isValueWriteable in class DirBasedAuthentication
      Parameters:
      name - property name
      Returns:
      true if the property is not security related
    • getValueDescriptor

      public IDescriptor getValueDescriptor(Locale locale, String name)
      Retrieves the descriptor of the given value parameter by name.
      Overrides:
      getValueDescriptor in class DirBasedAuthentication
      Parameters:
      locale - user locale
      name - property name
      Returns:
      descriptor of the requested property
    • populate

      public void populate(AuthToken token, Request request) throws EProfileException
      Description copied from class: AuthManager
      Populates authentication specific information into the request for auditing purposes.
      Overrides:
      populate in class DirBasedAuthentication
      Parameters:
      token - authentication token
      request - request
      Throws:
      EProfileException - failed to populate
    • isSSLClientRequired

      public boolean isSSLClientRequired()
      Description copied from class: AuthManager
      Checks if this authenticator requires SSL client authentication.
      Overrides:
      isSSLClientRequired in class DirBasedAuthentication
      Returns:
      client authentication required or not